Layer Definition Schema
LAYER Element
See Also  Send comments on this topic.
Layer Definition Schema : LAYER Element

Glossary Item Box

Description

When used in a layer definition, LAYER is used to define the layer's custom characteristics.

Diagram

SYSTEMOBJECTS Element SYMBOLOGY Element QUERY Element LOCALE Element HYPERLINK Element FORMS Element FIND Element Sequence LAYER Element

Overview

LAYER
When used in a layer definition, LAYER is used to define the layer's custom characteristics.
brightness optional Restriction of xs:int
Brightness adjustment for the layer. Positive values increase the whiteness of the layer, negative values increase the darkness of the layer.
contrast optional Restriction of xs:int
Contrast adjustment for the layer. Positive values exaggerate color separation (as the value approaches 1, the result is either pure black (for colors below the grey threshold) or pure solid color (for colors above the threshold), for example, a dark red will become pitch black, whereas a bright red will become solid red). Negative values merge/dissolve the colors (as the value approaches -1, the result is all gray).
maxscale optional xs:string
Maximum scale to display the layer using a relative scale such as 1:24000.
minscale optional xs:string
Minimum scale to display the layer using a relative scale such as 1:24000.
name optional xs:string
Name of the layer. Can be an alias.
onafterlayerdraw optional
Specify the script to run when this event occurs.
onbeforelayerdraw optional
Specify the script to run when this event occurs.
onclose optional
Specify the script to run when this event occurs.
onfeatureadded optional
Specify the script to run when this event occurs.
onfeaturechanged optional
Specify the script to run when this event occurs.
onfeaturedeleted optional
Specify the script to run when this event occurs.
onfeaturegeometrychanged optional
Specify the script to run when this event occurs.
onidentify optional
Specify the script to run when this event occurs.
onopen optional
Specify the script to run when this event occurs.
readonly optional Restriction of xs:string
Specifies whether the layer can be edited in ArcPad. When readonly is true, the layer cannot be made editable.
refscale optional xs:string
Reference scale to display the symbology for the layer. The scale is specfied using a relative scale such as 1:24000. Symbols are scaled relative to the refscale as the map is zoomed in or out.
transparency optional Restriction of xs:int
Transparency percentage for the layer (0 = 100 % transparent; 1 = 100 % opaque).
transparencycolor optional
Transparency color for the layer. This color will be rendered transparent in the map.
showeditformnew optional Restriction of xs:string
Specifies whether the edit form is shown whilst collecting new features in the layer.
Sequence
FIND
Parent tag for stored Find tool queries in an ArcPad layer definition.
FORMS
The parent element for defining an ArcPad form.
HYPERLINK
Used to specify the hyperlink properties of a layer in an ArcPad layer definition or ArcPad map file (*.apm).
LOCALE
Used to specify the codepage of the shapefile's .DBF table.
QUERY
Defines a filter, or definition query, for an AXF layer.
SYMBOLOGY
The parent element for symbology in an ArcPad map file (*.apm) or layer definition.
SYSTEMOBJECTS
Used to associate scripts with ArcPad system object events.Used in applet (*.apa) files, default configuration (ArcPad.apx) files, and layer definitions to associate scripts with ArcPad system object events.

Attributes

NameTypeUseDefaultFixedDescription
brightnessRestriction of xs:intoptional0 Brightness adjustment for the layer. Positive values increase the whiteness of the layer, negative values increase the darkness of the layer.
contrastRestriction of xs:intoptional0 Contrast adjustment for the layer. Positive values exaggerate color separation (as the value approaches 1, the result is either pure black (for colors below the grey threshold) or pure solid color (for colors above the threshold), for example, a dark red will become pitch black, whereas a bright red will become solid red). Negative values merge/dissolve the colors (as the value approaches -1, the result is all gray).
maxscalexs:stringoptional  Maximum scale to display the layer using a relative scale such as 1:24000.
minscalexs:stringoptional  Minimum scale to display the layer using a relative scale such as 1:24000.
namexs:stringoptional  Name of the layer. Can be an alias.
onafterlayerdraw optional  Specify the script to run when this event occurs.
onbeforelayerdraw optional  Specify the script to run when this event occurs.
onclose optional  Specify the script to run when this event occurs.
onfeatureadded optional  Specify the script to run when this event occurs.
onfeaturechanged optional  Specify the script to run when this event occurs.
onfeaturedeleted optional  Specify the script to run when this event occurs.
onfeaturegeometrychanged optional  Specify the script to run when this event occurs.
onidentify optional  Specify the script to run when this event occurs.
onopen optional  Specify the script to run when this event occurs.
readonlyRestriction of xs:stringoptional  Specifies whether the layer can be edited in ArcPad. When readonly is true, the layer cannot be made editable.
refscalexs:stringoptional  Reference scale to display the symbology for the layer. The scale is specfied using a relative scale such as 1:24000. Symbols are scaled relative to the refscale as the map is zoomed in or out.
transparencyRestriction of xs:intoptional1 Transparency percentage for the layer (0 = 100 % transparent; 1 = 100 % opaque).
transparencycolor optional  Transparency color for the layer. This color will be rendered transparent in the map.
showeditformnewRestriction of xs:stringoptionaltrue Specifies whether the edit form is shown whilst collecting new features in the layer.

Remarks

  • The minscale and maxscale attribute values specified for a layer in an ArcPad map file (*.apm) override the minscale and maxscale attribute values specified for that layer in its layer file (*.apl).

Examples

Restrictions

When used in a map file (*.apm):

  • edit can only be true for one layer of each main ShapeType (Point, PolyLine, Polygon).
  • edit cannot be true for MultiPoint shapefiles (types 8, 18 and 28).

Source

<xs:element name="LAYER" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>When used in a layer definition, LAYER is used to define the layer's custom characteristics.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="apl:FIND" />
      <xs:element ref="apl:FORMS" />
      <xs:element ref="apl:HYPERLINK">
        <xs:annotation>
          <xs:documentation>Used to specify the hyperlink properties of a layer in an ArcPad layer definition or ArcPad map file (*.apm).</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element ref="apl:LOCALE" />
      <xs:element ref="apl:QUERY" />
      <xs:element ref="apl:SYMBOLOGY" />
      <xs:element ref="apl:SYSTEMOBJECTS" />
    </xs:sequence>
    <xs:attribute name="brightness" default="0">
      <xs:annotation>
        <xs:documentation>Brightness adjustment for the layer. Positive values increase the whiteness of the layer, negative values increase the darkness of the layer.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="-1" />
          <xs:maxInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="0" name="contrast">
      <xs:annotation>
        <xs:documentation>Contrast adjustment for the layer. Positive values exaggerate color separation (as the value approaches 1, the result is either pure black (for colors below the grey threshold) or pure solid color (for colors above the threshold), for example, a dark red will become pitch black, whereas a bright red will become solid red). Negative values merge/dissolve the colors (as the value approaches -1, the result is all gray).</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="-1" />
          <xs:maxInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="maxscale" type="xs:string">
      <xs:annotation>
        <xs:documentation>Maximum scale to display the layer using a relative scale such as 1:24000.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="minscale" type="xs:string">
      <xs:annotation>
        <xs:documentation>Minimum scale to display the layer using a relative scale such as 1:24000.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="name" type="xs:string">
      <xs:annotation>
        <xs:documentation>Name of the layer. Can be an alias.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onafterlayerdraw">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onbeforelayerdraw">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onclose">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onfeatureadded">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onfeaturechanged">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onfeaturedeleted">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onfeaturegeometrychanged">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onidentify">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onopen">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="readonly">
      <xs:annotation>
        <xs:documentation>Specifies whether the layer can be edited in ArcPad. When readonly is true, the layer cannot be made editable.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="refscale" type="xs:string">
      <xs:annotation>
        <xs:documentation>Reference scale to display the symbology for the layer. The scale is specfied using a relative scale such as 1:24000. Symbols are scaled relative to the refscale as the map is zoomed in or out.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="1" name="transparency">
      <xs:annotation>
        <xs:documentation>Transparency percentage for the layer (0 = 100 % transparent; 1 = 100 % opaque).</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="0" />
          <xs:maxInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="transparencycolor">
      <xs:annotation>
        <xs:documentation>Transparency color for the layer. This color will be rendered transparent in the map.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="true" name="showeditformnew">
      <xs:annotation>
        <xs:documentation>Specifies whether the edit form is shown whilst collecting new features in the layer.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

© 2013 All Rights Reserved.